.. _ocafilterpolynomial: 1.1.1.11 OcaFilterPolynomial ============================= Class Hierarchy: :ref:`OcaRoot ` : :ref:`OcaWorker ` : :ref:`OcaActuator ` : :ref:`OcaFilterPolynomial ` .. cpp:class:: OcaFilterPolynomial: OcaActuator Generic Z-domain rational polynomial filter section with transfer function expression of the form: A(0) + A(1)z + A(2)z^2 + A(3)z^3 + ... B(0) + B(1)z + B(2)z^2 + B(3)z^3 + ... **Properties**: .. _ocafilterpolynomial_a: .. cpp:member:: OcaList A Numerator - "A" This property has id ``4.1``. .. _ocafilterpolynomial_b: .. cpp:member:: OcaList B Denominator - "B" This property has id ``4.2``. .. _ocafilterpolynomial_classid: .. cpp:member:: static const OcaClassID ClassID = "1.1.1.11" Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the **OcaRoot** property. This property has id ``1.1``. .. _ocafilterpolynomial_classversion: .. cpp:member:: static const OcaClassVersionNumber ClassVersion = 3 Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the **OcaRoot** property. This property has id ``1.2``. .. _ocafilterpolynomial_maxorder: .. cpp:member:: const OcaUint8 MaxOrder Maximum order of A[] and B[], i.e. the maximum size of the A[] and B[] arrays. Readonly. This property has id ``4.4``. .. _ocafilterpolynomial_samplerate: .. cpp:member:: OcaFrequency SampleRate Sampling rate inside the filter. Note: This rate is not necessarily the same as the Device input or output sampling rate. This property has id ``4.3``. Properties inherited from :ref:`ocaactuator`: - :cpp:texpr:`OcaClassID` :ref:`OcaRoot::ClassID ` - :cpp:texpr:`OcaClassVersionNumber` :ref:`OcaRoot::ClassVersion ` - :cpp:texpr:`OcaBoolean` :ref:`OcaRoot::Lockable ` - :cpp:texpr:`OcaLockState` :ref:`OcaRoot::LockState ` - :cpp:texpr:`OcaONo` :ref:`OcaRoot::ObjectNumber ` - :cpp:texpr:`OcaString` :ref:`OcaRoot::Role ` - :cpp:texpr:`OcaClassID` :ref:`OcaWorker::ClassID ` - :cpp:texpr:`OcaClassVersionNumber` :ref:`OcaWorker::ClassVersion ` - :cpp:texpr:`OcaBoolean` :ref:`OcaWorker::Enabled ` - :cpp:texpr:`OcaString` :ref:`OcaWorker::Label ` - :cpp:texpr:`OcaTimeInterval` :ref:`OcaWorker::Latency ` - :cpp:texpr:`OcaONo` :ref:`OcaWorker::Owner ` - :cpp:texpr:`OcaMap` :ref:`OcaWorker::PortClockMap ` - :cpp:texpr:`OcaList` :ref:`OcaWorker::Ports ` - :cpp:texpr:`OcaClassID` :ref:`OcaActuator::ClassID ` - :cpp:texpr:`OcaClassVersionNumber` :ref:`OcaActuator::ClassVersion ` **Methods**: .. _ocafilterpolynomial_getcoefficients: .. cpp:function:: OcaStatus GetCoefficients(OcaList &A, OcaList &B) Gets the polynomial coefficients. This method has id ``4.1``. - :cpp:expr:`A`: Output parameter. - :cpp:expr:`B`: Output parameter. .. _ocafilterpolynomial_setcoefficients: .. cpp:function:: OcaStatus SetCoefficients(OcaList A, OcaList B) Sets the polynomial coefficients. This method has id ``4.2``. - :cpp:expr:`A`: Input parameter. - :cpp:expr:`B`: Input parameter. .. _ocafilterpolynomial_getsamplerate: .. cpp:function:: OcaStatus GetSampleRate(OcaFrequency &Rate, OcaFrequency &minRate, OcaFrequency &maxRate) Gets the filter sampling rate value and limits. This method has id ``4.3``. - :cpp:expr:`Rate`: Output parameter. - :cpp:expr:`minRate`: Output parameter. - :cpp:expr:`maxRate`: Output parameter. .. _ocafilterpolynomial_setsamplerate: .. cpp:function:: OcaStatus SetSampleRate(OcaFrequency Rate) Sets the filter sampling rate. This method has id ``4.4``. - :cpp:expr:`Rate`: Input parameter. .. _ocafilterpolynomial_getmaxorder: .. cpp:function:: OcaStatus GetMaxOrder(OcaUint8 &Order) Gets the maximum allowable order (= max number of array elements in numerator and for denominator arrays) This method has id ``4.5``. - :cpp:expr:`Order`: Output parameter. Methods inherited from :ref:`ocaactuator`: - :ref:`OcaActuator::GetClassIdentification ` - :ref:`OcaActuator::GetLockable ` - :ref:`OcaActuator::GetLockState ` - :ref:`OcaActuator::GetRole ` - :ref:`OcaActuator::SetLockNoWrite ` - :ref:`OcaActuator::SetLockNoReadWrite ` - :ref:`OcaActuator::Unlock ` - :ref:`OcaActuator::AddPort ` - :ref:`OcaActuator::DeletePort ` - :ref:`OcaActuator::DeletePortClockMapEntry ` - :ref:`OcaActuator::GetEnabled ` - :ref:`OcaActuator::GetLabel ` - :ref:`OcaActuator::GetLatency ` - :ref:`OcaActuator::GetOwner ` - :ref:`OcaActuator::GetPath ` - :ref:`OcaActuator::GetPortClockMap ` - :ref:`OcaActuator::GetPortClockMapEntry ` - :ref:`OcaActuator::GetPortName ` - :ref:`OcaActuator::GetPorts ` - :ref:`OcaActuator::SetEnabled ` - :ref:`OcaActuator::SetLabel ` - :ref:`OcaActuator::SetLatency ` - :ref:`OcaActuator::SetPortClockMap ` - :ref:`OcaActuator::SetPortClockMapEntry ` - :ref:`OcaActuator::SetPortName `